package org.jsola.contract.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.contract.dto.ContractCredentialSiteAddDTO;
import org.jsola.contract.dto.ContractCredentialSiteUpdateDTO;
import org.jsola.contract.query.ContractCredentialSiteQuery;
import org.jsola.contract.vo.ContractCredentialSiteListVO;
import org.jsola.contract.vo.ContractCredentialSiteVO;
import org.jsola.core.Page;
import org.jsola.core.Result;

import java.util.List;

/**
 * 租户开通的电子合同账号
 *
 * @author JanusMix
 */
@Api(tags = "contract-租户开通的电子合同账号")
public interface IContractCredentialSiteControllerAPI {

    /**
     * 新增租户开通的电子合同账号
     * @param contractCredentialSiteAddDTO 租户开通的电子合同账号新增实体
     * @return 租户开通的电子合同账号展示对象
     */
    @ApiOperation(value = "新增租户开通的电子合同账号")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractCredentialSiteAddDTO", dataType = "ContractCredentialSiteAddDTO", value = "新增租户开通的电子合同账号", paramType = "body")
    })
    Result<ContractCredentialSiteVO> save(ContractCredentialSiteAddDTO contractCredentialSiteAddDTO);


    /**
     * 修改租户开通的电子合同账号
     * @param contractCredentialSiteUpdateDTO 租户开通的电子合同账号
     * @return 更新数量
     */
    @ApiOperation(value = "修改租户开通的电子合同账号")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractCredentialSiteUpdateDTO", dataType = "ContractCredentialSiteUpdateDTO", value = "修改租户开通的电子合同账号", paramType = "body")
    })
    Result<Integer> update(ContractCredentialSiteUpdateDTO contractCredentialSiteUpdateDTO);




    /**
     * 删除单个租户开通的电子合同账号，彻底删除
     * @param contractCredentialSiteId 租户开通的电子合同账号id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个租户开通的电子合同账号，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractCredentialSiteId", dataType = "Long", value = "租户开通的电子合同账号id", paramType = "path")
    })
    Result<Integer> delete(Long contractCredentialSiteId);


    /**
     * 批量删除租户开通的电子合同账号，彻底删除
     * @param contractCredentialSiteIds 租户开通的电子合同账号id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除租户开通的电子合同账号，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractCredentialSiteIds", dataType = "Long[]", value = "租户开通的电子合同账号id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(Long[] contractCredentialSiteIds);


    /**
     * 根据租户开通的电子合同账号id查询租户开通的电子合同账号详情
     * @param contractCredentialSiteId 租户开通的电子合同账号id
     * @return 租户开通的电子合同账号详情
     */
    @ApiOperation(value="根据租户开通的电子合同账号id查询租户开通的电子合同账号详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractCredentialSiteId", dataType = "Long", value = "租户开通的电子合同账号id", paramType = "path")
    })
    Result<ContractCredentialSiteVO> findById(Long contractCredentialSiteId);


    /**
     * 查询租户开通的电子合同账号
     * @param contractCredentialSiteQuery 租户开通的电子合同账号查询参数
     * @return page
     */
    @ApiOperation(value="查询租户开通的电子合同账号")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractCredentialSiteQuery", dataType = "ContractCredentialSiteQuery", value = "租户开通的电子合同账号查询参数", paramType = "query")
    })
    Result<List<ContractCredentialSiteListVO>> listAll(ContractCredentialSiteQuery contractCredentialSiteQuery);


     /**
     * 分页查询租户开通的电子合同账号
     * @param contractCredentialSiteQuery 租户开通的电子合同账号查询参数
     * @return page
     */
    @ApiOperation(value="分页查询租户开通的电子合同账号")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "contractCredentialSiteQuery", dataType = "ContractCredentialSiteQuery", value = "租户开通的电子合同账号查询参数", paramType = "query")
    })
    Result<Page<ContractCredentialSiteListVO>> page(ContractCredentialSiteQuery contractCredentialSiteQuery);


}

